                                                   _
                 ___  _ __   ___ _ __   __ _  __ _| |_ ___
                / _ \| '_ \ / _ \ '_ \ / _` |/ _` | __/ _ \
               | (_) | |_) |  __/ | | | (_| | (_| | ||  __/
                \___/| .__/ \___|_| |_|\__, |\__,_|\__\___|
                     |_|               |___/


OpenGate download openvpn config files from VPN Gate


## Downloading

You can find the latest version of OpenGate [here](https://notabug.org/shadowfox/OpenGate/releases).

## Installing

Installing OpenGate can be pretty straight forward and a simple. Simply
type the following command to your terminal and you're good to go.

```
# make install
```

It'll install the binary on `/usr/bin`, the man page on `/usr/share/man/`


## Basic Usage

Using OpenGate is simple, just type into your terminal the following command:

```
$ opengate
```

It'll download all available servers (in UDP) and save it
on `~/.config/opengate/udp/`.

You can download specific vpns filtering by country and protocol. For example:

```
$ opengate -p tcp -c jp
```

It'll download all available vpns from Japan in tcp.

You can also clean your vpns list and keep only the best ones. Here's an
example of the command cleaning the tcp vpns.

```
$ opengate -r -p tcp
```

## Uninstall

To uninstall OpenGate just run the following command on the extracted folder

```
# make uninstall
```

## Dependencies

To run OpenGate you'll need to have netcat (0.7.1 or newer), curl (7.56.1
or newer) amd wget (1.19.2 or newer).

## Contributing

Contributing to OpenGate is quite simple. Just follow the following steps:

1. Fork the repo.
2. Clone the project to your own machine.
3. Commit changes to your own branch.
4. Push your work back up to your fork.
5. Submit a Pull request so that we can review your changes.


## Author

Shadowfox <bitplease@shadowfox.top>

